home *** CD-ROM | disk | FTP | other *** search
/ Popular Request / By Popular Request (Arsenal Computer)(SysOptics Distribution System).ISO / amiga4 / umsfi152.lha / Fido / UMSFido.doc < prev    next >
Text File  |  1993-11-19  |  9KB  |  273 lines
  1. Manual for FidoExport 1.52 and FidoImport 1.52
  2. """"""""""""""""""""""""""""""""""""""""""""""
  3.  
  4. Overview
  5. ========
  6.  
  7. To  run a fido point with UMS you need FidoImport, FidoExport, TrapDoor and
  8. naturally UMS itself and a UMS newsreader.
  9.  
  10. FidoImport  is  used  to  import fido messages to the ums messagebase which
  11. were  transmitted  by  TrapDoor.  FidoExport is used to export new messages
  12. from the messagebase into a format which will be transmitted by TrapDoor.
  13.  
  14. The format of those so called packet file can be found in fido literature
  15. (FTC files).  TrapDoor's manual explains the naming sheme of the files.
  16.  
  17.  
  18. Installation - The Variables
  19. ============================
  20.  
  21. FidoImport  and  FidoExport are configured by using variables in the global
  22. ums.config. Each system with fido technologie you are connected to must
  23. have it's own user entry. Additionally one has to configure the following
  24. variables. An asterix ("*") marks variables which may be omitted.
  25.  
  26.  
  27.    fido.netname
  28.  
  29. name  of  the  network  using  "Fido  Technology".   This  will  be used as
  30. identification     for     groups     ("netname.group")     and    messages
  31. ("z:n/f.p@netmane") of this net.  When usings fidonet itself use "fidonet".
  32. "readaccess"  and  "writeaccess"  of  the  respective  user must match (eg.
  33. readaccess  =  "fidonet.#?").   Also  "export"'s  pattern should be correct
  34. (e.g.  export = "#?@fidonet").
  35.  
  36.  
  37.    fido.pointaddress
  38.    fido.fakeaddress (*)
  39.    fido.stoneage (*)
  40.    fido.createINTL (*)
  41.  
  42. These variables describe your own fido address.  "pointaddress" is the full
  43. 4D  address  of your system.  "fakeaddress" is necessary if the software of
  44. your boss doesn't create 4D packets.  If your boss can't handle incoming 4D
  45. packets you must set "stoneage" to "y" and only 3D packets will be created.
  46. Don't  forget  an  AKA  for  you  address.   If  "createINTL" is set to "y"
  47. FidoExport crates an INTL kludge for every netmail.  This prevents problems
  48. with some software when using multiple networks with fido technology.
  49.  
  50.  
  51.    fido.bossaddress
  52.  
  53. This is the address of your boss.
  54.  
  55.  
  56.    fido.mausgate (*)
  57.    fido.rfcgate (*)
  58.  
  59. These are the addresses of gateways to "Maus" and RFC nets. You must supply
  60. them if FidoExport should export messages to this nets.
  61.  
  62.  
  63.    fido.defaultorigin
  64.  
  65. This is the origin which will be used if a message dosn't have an origin.
  66.  
  67.  
  68.    fido.inbound
  69.    fido.outbound
  70.    fido.tmpdir (*)
  71.  
  72. These  are  the paths (including tailing "/" or ":") of the directories for
  73. outgoing and incoming packets.
  74.  
  75.  
  76.    fido.arccmd
  77.    fido.dearccmd
  78.    fido.junkcmd
  79.  
  80. These  AmigaDOS commands are used for bundling and unbundling packets.  For
  81. malformed  packets  "junkcmd"  is called.  Using "%s" in the command string
  82. (up to 4 times) the name of the packet may be inserted.
  83.  
  84.  
  85.    fido.charset.xy (*)
  86.  
  87. FidoImport  knows  about ALL charsets defined in FSC 54.  There are however
  88. many  fido programs,  that use different (undefined, illegal) names for the
  89. same  charsets.  In order to make these work anyways, you can redirect them
  90. to known charset.
  91.  
  92. Known charsets (FSC 54) are:
  93.  
  94. Level 2: "LATIN-1", "IBMPC", "MAC"
  95. Level 1:  "GERMAN", "FRENCH", "DUTCH", "FINNISH", "CANADIAN",
  96. "ITALIAN", "NORWEG", "PORTU", "SPANISH", "SWEDISH", "SWISS", "UK"
  97.  
  98. Example:   "fido.charset.ISO-8859-1  =  LATIN-1"  redirects "ISO-8859-1" to
  99. "LATIN-1".
  100.  
  101.  
  102.    fido.ascii (*)
  103.  
  104. this  pattern  marks  areas  which  don't  allow other characters than pure
  105. ASCII.  FidoExport converts all special characters (like umlauts) for these
  106. areas.   All  other  groups  get  special  characters with a proper charset
  107. kludge.
  108.  
  109.  
  110.    fido.security (*)
  111.  
  112. This string contains flags that enable certain security methods:
  113.  
  114.   PKTADR - only import a packet if its destination matches the local
  115.            address.
  116.  
  117.   PKTPWD - use packets password for login.  Default login will be used
  118.            if this failes or a password does't exist.  If not specified, ""
  119.            will be tried as a password, too.
  120.  
  121.   SESSIONPWD - use TrapDoor's filenote (password "") for logins only
  122.                if session was password protected.
  123.  
  124. With  PKTPWD  and  SESSIONPWD  make  it  possible  to  guarantee  that only
  125. authentic  users (fido nodes) gain access to higer privileged UMS accounts.
  126. This is, of course, only usefull for nodes.  Points won't use it.
  127.  
  128.  
  129.    fido.debuglevel (*)
  130.    fido.loglevel (*)
  131.    fido.reportlevel (*)
  132.    fido.reportuser (*)
  133.  
  134. FidoImport and FidoExport create 3 different kinds of debug-/log information:
  135.  - debug (stdout)
  136.  - log (ums logfile, managed by umsserver)
  137.  - report (a mail, that is sent to the 'reportuser')
  138.  
  139. Levels are organized similiar to umsserver:  the bigger the value, the more
  140. output  is  created.   The  outputs  with  lower  values represent the more
  141. important  information  or  the  more  serious errors.  <5 means error, >=5
  142. means log-/debug information.
  143.  
  144.  
  145. Installation - Hints / Example
  146. ==============================
  147.  
  148. It's  very  important that certain variables can be local to the user entry
  149. of your boss.
  150.  
  151. as an example all important lines of my ums.config:
  152.  
  153. -- cut --------------------------------------------------------------------
  154. fido.inbound            = "UMS:Inbound/"
  155. fido.outbound           = "UMS:Outbound/"
  156. fido.junkcmd            = "Copy %s UMS:Bad/ *n Delete %s"
  157. fido.mausgate           = "2:242/2.6"
  158. fido.rfcgate            = "2:242/6.1"
  159. fido.debuglevel         = 8
  160. fido.loglevel           = 6
  161. fido.reportlevel        = 5
  162. fido.reportuser         = SYSOP
  163. fido.charset.ISO-8859-1 = LATIN-1
  164. fido.ascii              = ~(fidonet.(AMIGA.GER|IBASE.POINTS|AMIPROG.GER|UMS.GER))
  165. fido.defaultorigin      = "Amiga Modula & Oberon Klub (AMOK) Stuttgart"
  166.  
  167. user
  168.   name              = Intuition-Base
  169.   alias             = fido.2.2407.106.0
  170.   alias             = fido.default
  171.   readaccess        = "fidonet.#?"
  172.   writeaccess       = "fidonet.#?"
  173.   import            = #?
  174.   export            = "(#?@fidonet|#?.maus)"
  175.   netaccess         = #?
  176.   distribution      = #?
  177.   fido.netname      = "fidonet"
  178.   fido.pointaddress = "2:2407/106.3"
  179.   fido.bossaddress  = "2:2407/106.0"
  180.   fido.arccmd       = "LhA -I -u -m -U2048 m %s %s"
  181.   fido.dearccmd     = "LhA -I -m -f -x0 -U8192 x %s %s"
  182. enduser
  183. -- cut --------------------------------------------------------------------
  184.  
  185. each  user  entry  of  a  fido  system  must  have  an  alias  in  the form
  186. "fido.z.n.f.p".  FidoImport uses this to log in.
  187.  
  188. The user entry of your default node gets the line <alias = fido.default>.
  189.  
  190. <readaccess> and <writeaccess> must respect <fido.netname>.
  191.  
  192. <import>, <netaccess> and <distribution> should be "#?" for now.
  193.  
  194. You  shold  think  abount  the <export> pattern.  If you are only running a
  195. fido  point  an  do  not  paticipate in other nets a simple "#?" is enough.
  196. Otherwise  you  must  choose  a  pattern which doesn't overlap the <export>
  197. patterns of other nets.
  198.  
  199.  
  200. Polling more than one fido systems
  201. ==================================
  202.  
  203. Just  add  additional user entries for the other nodes.  Using <readaccess>
  204. and  <export>  you  must specify which echos and which mail is exported the
  205. which node.
  206.  
  207.  
  208. Paticipating in other nets with "Fido Technology"
  209. =================================================
  210.  
  211. Just  add  additional  user  entries  and choose a proper <netname>.  Don't
  212. forget to set fido.bossaddress / fido.poibtaddress to approbriate messages.
  213.  
  214.  
  215. Addressig of Mails
  216. ==================
  217.  
  218. All   addresses   must   be   in   a   special   format.    You   must  use
  219. "2:123/4.5@fidonet"  instead  of simply "2:123/4.5".  "@fidonet" is just an
  220. example.   Use the proper <netname> instead.  Mails without proper adresses
  221. will not be exported!
  222.  
  223.  
  224. Special features
  225. =================
  226.  
  227. In  order to send file attaches you must add "file-attach" to the attribute
  228. field  of  a  mail.  The subject of the mail specifies the full path of the
  229. file.   (e.g.   "Mail:Uploads/AttachMe.LHA").  If you also specify "delete"
  230. the file will be deleted after sending.
  231.  
  232. You  can  create  crash  mail  by  adding "crash" to the attributes.  These
  233. messages  will  be  directly  exported  to  the  boss of the receiver.  Use
  234. TrapDoor to call the proper node.
  235.  
  236.  
  237. Usage of FidoImport
  238. ===================
  239.  
  240. The template of FidoImport is:
  241.  
  242. NAME,PASSWORD,SERVER/K,INBOUND/K,PRESERVE/S
  243.  
  244. If  no  default  login  is  given, "fido.default" will be used.  FidoExport
  245. tries  to  get  a  proper  login from TradDoor's filenates and/or 4D packet
  246. headers.
  247.  
  248.  
  249. Usage of FidoExport
  250. ===================
  251.  
  252. The template of FidoExport is:
  253.  
  254.   USER,PASSWORD,SERVER/K
  255.  
  256. USER  and  PASSWORD  specify  the  user  entry of the fido node you want to
  257. export to.  If they are omitted FidoExport uses "fido.default".
  258.  
  259.  
  260. Epilogue
  261. ========
  262.  
  263. Please send bug reports and suggestion to
  264.  
  265. Kai Bolay
  266. Hoffmannstra▀e 168         E-Mail: UUCP: kai@amokle.stgt.sub.org
  267. 71229 Leonberg                     FIDO: 2:2407/106.3
  268.  
  269. Martin Horneffer
  270. Warmweiherstra▀e 18        E-Mail: UUCP: mh@umshq.adsp.sub.org
  271. 52066 Aachen                       FIDO: 2:242/7.9
  272.                                    MAUS: AC.maus, AC2.maus
  273.